/*******************************************************************************
 * Copyright 2009, 2010 Innovation Gate GmbH. All Rights Reserved.
 * 
 * This file is part of the OpenWGA server platform.
 * 
 * OpenWGA is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 * 
 * In addition, a special exception is granted by the copyright holders
 * of OpenWGA called "OpenWGA plugin exception". You should have received
 * a copy of this exception along with OpenWGA in file COPYING.
 * If not, see <http://www.openwga.com/gpl-plugin-exception>.
 * 
 * OpenWGA is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 * 
 * You should have received a copy of the GNU General Public License
 * along with OpenWGA in file COPYING.
 * If not, see <http://www.gnu.org/licenses/>.
 ******************************************************************************/

package de.innovationgate.webgate.api;

/**
 * All transient data of a document belonging to the query that was used to fetch it  
 */
public class SearchDetails {

    private Float _score;
    private Object _explanation;
    
    
    /**
     * Returns the search score (i.e. relevance) of this document in the query
     */
    public Float getScore() {
        return _score;
    }
    
    /**
     * Sets the search score (i.e. relevance) of this document in the query
     */
    public void setScore(Float score) {
        _score = score;
    }
    
    /**
     * Return an explantion about the role of the document inside the query
     */
    public Object getExplanation() {
        return _explanation;
    }
    
    /**
     * Sets an explantion about the role of the document inside the query
     */
    public void setExplanation(Object explanation) {
        _explanation = explanation;
    }
    
  
        
}
